/* Copyright 2007-2008 dnAnalytics Project.
 *
 * Contributors to this file:
 * Patrick van der Velde
 * Marcus Cuda
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 * 
 * * Redistributions of source code must retain the above copyright notice, this 
 *   list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright notice, 
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * * Neither the name of the dnAnalytics Project nor the names of its contributors
 *   may be used to endorse or promote products derived from this software without
 *   specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
namespace dnAnalytics.LinearAlgebra.IO
{
    /// <summary>
    /// Enumeration of the different DenseMatrix Market storage formats.
    /// </summary>
    public enum StorageFormat
    {
        /// <summary>
        /// A standard matrix with no special properties.
        /// </summary>
        General,

        /// <summary>
        /// A square, symmetric matrix, <b>matrix[i,j] == matrix[j,i]</b>.
        /// </summary>
        Symmetric,

        /// <summary>
        /// A square, Hermitian matrix, <b>matrix[i,j] == matrix[j,i].Conjugate</b>.
        /// </summary>
        Hermitian,

        /// <summary>
        /// A square, skew-symmetric matrix, <b>matrix[i,j] == -matrix[j,i]</b>.
        /// </summary>
        SkewSymmetric
    }

    /// <summary>
    /// Enumeration of the different data types DenseMatrix Market files support. 
    /// </summary>
    public enum DataType
    {
        /// <summary>
        /// The matrix is real. DenseMatrix entries are represented by a single double.
        /// </summary>
        Real,

        /// <summary>
        ///  The matrix has only integer entries. DenseMatrix entries are represented by a single integer. 
        /// </summary>
        Integer,

        /// <summary>
        /// The matrix is complex. DenseMatrix entries are represented by two doubles, 
        /// the first giving the real part and the second the imaginary part.
        /// </summary>
        Complex,

        /// <summary>
        /// Only the matrix nonzero pattern is provided. DenseMatrix entries are omitted (only the nonzero pattern is supplied). 
        /// </summary>
        Pattern
    }

    /// <summary>
    /// Enumeration of the DenseMatrix Market exchange formats.
    /// </summary>
    public enum ExchangeFormat
    {
        /// <summary>
        /// A file format suitable for representing general dense matrices. All entries are provided in a predefined (column oriented) order.
        /// </summary>
        Array,
        /// <summary>
        /// A file format suitable for representing general sparse matrices. Only nonzero entries 
        /// are provided, and the coordinates of each nonzero entry are given explicitly.
        /// </summary>
        Coordinate
    }
}